kza_application_interface.h File Reference

Application interface. More...

#include <system/display/kzs_surface.h>
#include <system/display/kzs_window.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Data Structures
struct	KzaApplicationFPSConstraints
	Constraint for limiting the number of frames per second the Engine is rendering. More...
struct	KzaApplicationProperties
	Configurable application properties. More...

Typedefs
typedef kzsError(*	KzaApplicationOnStartupFunction )(struct KzaApplication *application)
	Function type of function callback for initialization. More...
typedef kzsError(*	KzaApplicationOnShutdownFunction )(struct KzaApplication *application)
	Function type of function callback for deinitialization. More...
typedef kzsError(*	KzaApplicationOnProjectLoadedFunction )(struct KzaApplication *application)
	Function type of function callback for initialization that is using the .KZB data. More...
typedef kzsError(*	KzaApplicationOnUpdateFunction )(struct KzaApplication *application, kzUint deltaTime)
	Function type of function callback for updating logic. More...
typedef kzsError(*	KzaApplicationOnPreRenderFunction )(const struct KzaApplication *application)
	Function type of function callback for rendering. More...
typedef kzsError(*	KzaApplicationOnPostRenderFunction )(const struct KzaApplication *application)
	Function type of function callback for rendering. More...
typedef kzsError(*	KzaApplicationOnApplicationEventFunction )(struct KzaApplication *application, struct KzaApplicationChangeEvent *changeEvent)
	Function type of event callback for application state changes. More...
typedef kzsError(*	KzaApplicationOnPointerInputEventFunction )(struct KzaApplication *application, const struct KzsInputEventPointer *inputData)
	Function type of event callback for pointing device input events. More...
typedef kzsError(*	KzaApplicationOnKeyInputEventFunction )(struct KzaApplication *application, const struct KzsInputEventKey *inputData)
	Function type of event callback for keyboard input events. More...
typedef kzsError(*	KzaApplicationOnWindowEventFunction )(struct KzaApplication *application, enum KzsEventType eventType, const struct KzuWindow *window)
	Function type of event callback for window events. More...

Functions
void	kzApplicationConfigure (const struct KzaSystemProperties *systemProperties, struct KzaApplicationProperties *configuration)
	Application configuration function. More...

Detailed Description

Application interface.

The functions declared here have no implementation in the Kanzi engine framework. Instead the application must provide the implementations.

Copyright 2008-2019 by Rightware. All rights reserved.

Typedef Documentation

typedef kzsError(* KzaApplicationOnStartupFunction)(struct KzaApplication *application)

Function type of function callback for initialization.

typedef kzsError(* KzaApplicationOnShutdownFunction)(struct KzaApplication *application)

Function type of function callback for deinitialization.

typedef kzsError(* KzaApplicationOnProjectLoadedFunction)(struct KzaApplication *application)

Function type of function callback for initialization that is using the .KZB data.

typedef kzsError(* KzaApplicationOnUpdateFunction)(struct KzaApplication *application, kzUint deltaTime)

Function type of function callback for updating logic.

This function is called for every frame.

typedef kzsError(* KzaApplicationOnPreRenderFunction)(const struct KzaApplication *application)

Function type of function callback for rendering.

This function is called for every frame before any other rendering function.

typedef kzsError(* KzaApplicationOnPostRenderFunction)(const struct KzaApplication *application)

Function type of function callback for rendering.

typedef kzsError(* KzaApplicationOnApplicationEventFunction)(struct KzaApplication *application, struct KzaApplicationChangeEvent *changeEvent)

Function type of event callback for application state changes.

typedef kzsError(* KzaApplicationOnPointerInputEventFunction)(struct KzaApplication *application, const struct KzsInputEventPointer *inputData)

Function type of event callback for pointing device input events.

typedef kzsError(* KzaApplicationOnKeyInputEventFunction)(struct KzaApplication *application, const struct KzsInputEventKey *inputData)

Function type of event callback for keyboard input events.

typedef kzsError(* KzaApplicationOnWindowEventFunction)(struct KzaApplication *application, enum KzsEventType eventType, const struct KzuWindow *window)

Function type of event callback for window events.

Function Documentation

void kzApplicationConfigure	(	const struct KzaSystemProperties *	systemProperties,
		struct KzaApplicationProperties *	configuration
	)

Application configuration function.

This function is called from kzaMain() when the application is started, but before it is initialized. This function must be implemented in the application that uses the application framework. The user can specify the application window properties, allocated RAM size, and set up various callback functions in kzApplicationConfigure() to control the execution later at desired points.

Parameters

systemProperties	Command line arguments from the operating system.
configuration	Application properties that can be modified inside kzApplicationConfigure() to set up callback functions, window properties, RAM size etc.